<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>TextPropCollection (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="TextPropCollection (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TextPropCollection.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/hslf/model/textproperties/TextPropCollection.html" target="_top">FRAMES</a></li>
<li><a href="TextPropCollection.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hslf.model.textproperties</p>
<h2 title="Class TextPropCollection" class="title">Class TextPropCollection</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hslf.model.textproperties.TextPropCollection</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>TextPropCollection</strong>
extends java.lang.Object</pre>
<div class="block">For a given run of characters, holds the properties (which could
  be paragraph properties or character properties).
 Used to hold the number of characters affected, the list of active
  properties, and the random reserved field if required.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#TextPropCollection(int)">TextPropCollection</a></strong>(int&nbsp;textSize)</code>
<div class="block">Create a new collection of text properties (be they paragraph
  or character) for a run of text without any</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#TextPropCollection(int, short)">TextPropCollection</a></strong>(int&nbsp;charactersCovered,
                  short&nbsp;reservedField)</code>
<div class="block">Create a new collection of text properties (be they paragraph
  or character) which will be groked via a subsequent call to
  buildTextPropList().</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#addWithName(java.lang.String)">addWithName</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Add the TextProp with this name to the list</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#buildTextPropList(int, org.apache.poi.hslf.model.textproperties.TextProp[], byte[], int)">buildTextPropList</a></strong>(int&nbsp;containsField,
                 <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>[]&nbsp;potentialProperties,
                 byte[]&nbsp;data,
                 int&nbsp;dataOffset)</code>
<div class="block">For an existing set of text properties, build the list of 
  properties coded for in a given run of properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#findByName(java.lang.String)">findByName</a></strong>(java.lang.String&nbsp;textPropName)</code>
<div class="block">Fetch the TextProp with this name, or null if it isn't present</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#getCharactersCovered()">getCharactersCovered</a></strong>()</code>
<div class="block">Fetch the number of characters this styling applies to</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#getReservedField()">getReservedField</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#getSpecialMask()">getSpecialMask</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.LinkedList&lt;<a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#getTextPropList()">getTextPropList</a></strong>()</code>
<div class="block">Fetch the TextProps that define this styling</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#setReservedField(short)">setReservedField</a></strong>(short&nbsp;val)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#updateTextSize(int)">updateTextSize</a></strong>(int&nbsp;textSize)</code>
<div class="block">Update the size of the text that this set of properties
  applies to</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextPropCollection.html#writeOut(java.io.OutputStream)">writeOut</a></strong>(java.io.OutputStream&nbsp;o)</code>
<div class="block">Writes out to disk the header, and then all the properties</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="TextPropCollection(int, short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TextPropCollection</h4>
<pre>public&nbsp;TextPropCollection(int&nbsp;charactersCovered,
                  short&nbsp;reservedField)</pre>
<div class="block">Create a new collection of text properties (be they paragraph
  or character) which will be groked via a subsequent call to
  buildTextPropList().</div>
</li>
</ul>
<a name="TextPropCollection(int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TextPropCollection</h4>
<pre>public&nbsp;TextPropCollection(int&nbsp;textSize)</pre>
<div class="block">Create a new collection of text properties (be they paragraph
  or character) for a run of text without any</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getSpecialMask()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSpecialMask</h4>
<pre>public&nbsp;int&nbsp;getSpecialMask()</pre>
</li>
</ul>
<a name="getCharactersCovered()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharactersCovered</h4>
<pre>public&nbsp;int&nbsp;getCharactersCovered()</pre>
<div class="block">Fetch the number of characters this styling applies to</div>
</li>
</ul>
<a name="getTextPropList()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextPropList</h4>
<pre>public&nbsp;java.util.LinkedList&lt;<a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>&gt;&nbsp;getTextPropList()</pre>
<div class="block">Fetch the TextProps that define this styling</div>
</li>
</ul>
<a name="findByName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findByName</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>&nbsp;findByName(java.lang.String&nbsp;textPropName)</pre>
<div class="block">Fetch the TextProp with this name, or null if it isn't present</div>
</li>
</ul>
<a name="addWithName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addWithName</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>&nbsp;addWithName(java.lang.String&nbsp;name)</pre>
<div class="block">Add the TextProp with this name to the list</div>
</li>
</ul>
<a name="buildTextPropList(int, org.apache.poi.hslf.model.textproperties.TextProp[], byte[], int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildTextPropList</h4>
<pre>public&nbsp;int&nbsp;buildTextPropList(int&nbsp;containsField,
                    <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>[]&nbsp;potentialProperties,
                    byte[]&nbsp;data,
                    int&nbsp;dataOffset)</pre>
<div class="block">For an existing set of text properties, build the list of 
  properties coded for in a given run of properties.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of bytes that were used encoding the properties list</dd></dl>
</li>
</ul>
<a name="updateTextSize(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateTextSize</h4>
<pre>public&nbsp;void&nbsp;updateTextSize(int&nbsp;textSize)</pre>
<div class="block">Update the size of the text that this set of properties
  applies to</div>
</li>
</ul>
<a name="writeOut(java.io.OutputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeOut</h4>
<pre>public&nbsp;void&nbsp;writeOut(java.io.OutputStream&nbsp;o)
              throws java.io.IOException</pre>
<div class="block">Writes out to disk the header, and then all the properties</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getReservedField()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReservedField</h4>
<pre>public&nbsp;short&nbsp;getReservedField()</pre>
</li>
</ul>
<a name="setReservedField(short)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setReservedField</h4>
<pre>public&nbsp;void&nbsp;setReservedField(short&nbsp;val)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TextPropCollection.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/hslf/model/textproperties/TextPropCollection.html" target="_top">FRAMES</a></li>
<li><a href="TextPropCollection.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
